/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * Neither the name of the HISP project nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.dxf2.datavalueset;

/**
 * An entry in an {@link DataValueSet} while processing it in context of a
 * {@link DataValueSetReader} or {@link DataValueSetWriter}.
 *
 * @author Jan Bernitt
 */
public interface DataValueEntry
{
    String getDataElement();

    String getPeriod();

    String getOrgUnit();

    String getCategoryOptionCombo();

    String getAttributeOptionCombo();

    String getValue();

    String getStoredBy();

    String getCreated();

    String getLastUpdated();

    String getComment();

    boolean getFollowup();

    Boolean getDeleted();

    default boolean hasLastUpdated()
    {
        String updated = getLastUpdated();
        return updated != null && !updated.isEmpty();
    }

    default boolean hasCreated()
    {
        String created = getCreated();
        return created != null && !created.isEmpty();
    }

    default String getPrimaryKey()
    {
        return getDataElement() + getPeriod() + getOrgUnit() + getCategoryOptionCombo() + getAttributeOptionCombo();
    }

    default boolean isNullValue()
    {
        return getValue() == null && getComment() == null;
    }

    default boolean isDeletedValue()
    {
        Boolean deleted = getDeleted();
        return deleted != null && deleted;
    }

}
